GET
/
v1
/
receiving
/
{type}
/
{id}
Get one Delivery
curl --request GET \
  --url https://{client_id}.shipstream.app/api/global/v1/receiving/{type}/{id}
{
  "resource": {
    "type": "ASN",
    "id": 123,
    "supplier_name": "<string>",
    "expected_at": "2019-12-03T21:06:26Z",
    "merchant_reference": "<string>",
    "supplier_invoice_reference": "<string>",
    "supplier_order_reference": "<string>",
    "shipment_type": "international_maritime_freight",
    "bill_of_lading": "<string>",
    "standard_carrier_alpha_code": "<string>",
    "warehouse": {
      "type": "Warehouse",
      "id": 123
    },
    "merchant": {
      "type": "Merchant",
      "id": 4
    },
    "increment_id": "11000020",
    "state": "new",
    "status": "new",
    "progress_percent": 50,
    "carrier_name": "<string>",
    "delivered_at": "2019-12-03T21:06:26Z",
    "receive_by": "2019-12-03T21:06:26Z",
    "processed_at": "2019-12-03T21:06:26Z",
    "putaway_at": "2019-12-03T21:06:26Z",
    "completed_at": "2019-12-03T21:06:26Z",
    "ready_to_process_at": "2019-12-03T21:06:26Z",
    "merchant_status": "<string>",
    "item_count": 123,
    "container_count": 123,
    "label_count": 123,
    "exception_count": 123,
    "processing_comments": "<string>",
    "special_requirements": [
      "<string>"
    ],
    "is_auto_commit": true,
    "created_at": "2017-07-21T17:32:28Z",
    "updated_at": "2017-07-21T17:39:43Z",
    "tracking_numbers": [
      {
        "type": "DeliveryTrackingNumber",
        "id": 123,
        "tracking_number": "<string>"
      }
    ],
    "status_history": [
      {
        "delivery_item": {
          "type": "DeliveryItem",
          "id": 3,
          "delivery": {
            "type": "ASN",
            "id": 3
          },
          "qty": 123,
          "qty_expected": 123,
          "qty_received": 123,
          "qty_shortage": 123,
          "qty_overage": 123,
          "qty_processed": 123,
          "qty_putaway": 123,
          "qty_committed": 123,
          "qty_returned": 123,
          "is_sku_merge_email_sent": true,
          "lots": [
            {
              "type": "DeliveryItemLot",
              "id": 3,
              "lot": {
                "type": "Lot",
                "id": 54
              },
              "qty_counted": 123,
              "qty_putaway": 123
            }
          ],
          "locations": [
            {
              "type": "DeliveryItemLocation",
              "id": 3,
              "location": {
                "type": "Location",
                "id": 42
              },
              "qty_putaway": 123,
              "qty_committed": 123
            }
          ],
          "exceptions": [
            {
              "type": "DeliveryItemException",
              "id": 3,
              "delivery_item": {
                "type": "DeliveryItem",
                "id": 123
              },
              "container": {
                "type": "DeliveryContainer",
                "id": 3,
                "container_type": {
                  "type": "DeliveryContainerType",
                  "id": 3,
                  "merchant": {
                    "type": "Merchant",
                    "id": 4
                  },
                  "delivery_type": "asn",
                  "name": "<string>",
                  "name_plural": "<string>",
                  "weight": {
                    "value": 20,
                    "unit": "lb"
                  },
                  "is_default": true,
                  "is_system": true
                },
                "damage_type": "none",
                "weight_discrepancy_reason": "none",
                "tare_weight": {
                  "value": 20,
                  "unit": "lb"
                },
                "weight": {
                  "value": 20,
                  "unit": "lb"
                },
                "weighed_at": "2019-12-03T21:06:26Z",
                "weighed_by": {
                  "type": "OrganizationUser",
                  "id": 3
                },
                "contents": [
                  {
                    "delivery_item": {
                      "type": "DeliveryItem",
                      "id": 123
                    },
                    "qty_counted": 123,
                    "qty_shortage": 123,
                    "qty_counted_per_lot": [
                      {
                        "lot": {
                          "type": "Lot",
                          "id": 54
                        },
                        "quantity": 123
                      }
                    ]
                  }
                ],
                "condition_note": "<string>",
                "item_count": 123
              },
              "lot": {
                "type": "Lot",
                "id": 54
              },
              "status": "new",
              "sign": 1,
              "reason": "<string>",
              "comment": "<string>",
              "qty": 123
            }
          ]
        },
        "status": "new",
        "exception": {
          "type": "Exception",
          "id": 123
        },
        "exception_status": "new",
        "comment": "<string>",
        "user": {
          "type": "OrganizationUser",
          "id": 3
        },
        "created_at": "2017-07-21T17:32:28Z",
        "package": {
          "type": "Package",
          "id": 123
        }
      }
    ]
  },
  "included": {
    "Merchant": [
      {
        "type": "Merchant",
        "id": 4,
        "code": "acme_inc",
        "name": "ACME Inc.",
        "is_active": true,
        "is_deleted": false,
        "sort_order": 5,
        "created_at": "2017-07-21T17:32:28Z",
        "brands": [
          {
            "type": "Brand",
            "id": 4
          }
        ],
        "default_brand": {
          "type": "Brand",
          "id": 4
        }
      }
    ],
    "Warehouse": [
      {
        "type": "Warehouse",
        "id": 3,
        "name": "East Coast 1",
        "is_active": true
      }
    ]
  }
}

Path Parameters

type
enum<string>
required

Specify the delivery type to which your operations will be restricted.

Available options:
asn,
rma
id
integer
required

The id of the referenced Delivery.

Required range: x >= 1

Query Parameters

fields:merchant
enum<string>[]

Specify additional fields of the Merchant object to be included in the response. See the selecting fields page for more information.

fields:warehouse
enum<string>[]

Specify additional fields of the Warehouse object to be included in the response. See the selecting fields page for more information.

Response

200
application/json

OK

The response is of type object.